Path

class Path(rawPath: String, resolve: Boolean)

Path handling utilities modeled after JVM's Path and Python's pathlib. By default resolves paths on creation. Disabling this may lead to errors.

Constructors

Path

fun Path(rawPath: String, resolve: Boolean = true)

Types

Companion

object Companion

Functions

ancestor

fun ancestor(great: Int): Path

Repeatedly gets parent.

append

suspend fun append(data: <ERROR CLASS>, createParents: Boolean = true)

Append data to this file, creating it if it doesn't exist.

suspend fun append(data: ByteArray, createParents: Boolean = true)

Append data to this file, creating it if it doesn't exist.

suspend fun append(data: String, encoding: String? = "utf8", createParents: Boolean = true)

Append data to this file, creating it if it doesn't exist.

appendLine

suspend fun appendLine(data: String, encoding: String? = "utf8", createParents: Boolean = true)

Append a line to this file (adds lineSeparator to data).

appendLineSync

fun appendLineSync(data: String, encoding: String? = "utf8", createParents: Boolean = true)

Append a line to this file (adds lineSeparator to data).

appendStream

fun appendStream(encoding: String? = "utf8", createParents: Boolean = true): <ERROR CLASS>

Create a stream to append to the file.

appendSync

fun appendSync(data: <ERROR CLASS>, createParents: Boolean = true)

Append data to this file, creating it if it doesn't exist.

fun appendSync(data: ByteArray, createParents: Boolean = true)

Append data to this file, creating it if it doesn't exist.

fun appendSync(data: String, encoding: String? = "utf8", createParents: Boolean = true)

Append data to this file, creating it if it doesn't exist.

contains

operator fun contains(segment: String): Boolean

See if this path contains a segment.

copy

suspend fun copy(dest: Path, recursive: Boolean = true, force: Boolean = true)

Copies this file or directory todest.

copyChildrenInto

suspend fun copyChildrenInto(destDir: Path, recursive: Boolean = true, force: Boolean = true)

Copy this directory's children into the directory destDir, creating it if it does not exist.

copyInto

suspend fun copyInto(destDir: Path, recursive: Boolean = true, force: Boolean = true)

Copy this file or directory intodestDir, creating it if it does not exist.

delete

suspend fun delete(recursive: Boolean = false)

Delete this path.

deleteRecursively

suspend fun deleteRecursively()

Delete this path recursively.

descendant

fun descendant(rest: Path): Path

Get a descendant.

fun descendant(rest: String): Path

Get a descendant.

div

operator fun div(rest: Path): Path

Get a descendant.

operator fun div(rest: String): Path

Get a descendant.

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

isDescendantOf

fun isDescendantOf(ancestor: Path): Boolean

Get if this is a descendant of ancestor.

fun isDescendantOf(ancestor: String): Boolean

Get if this is a descendant of ancestor.

mkdir

fun mkdir(parents: Boolean = true, existsOk: Boolean = true): Path

Make this directory.

move

suspend fun move(dest: Path, force: Boolean = true)

Move this file or directory todest.

moveChildrenInto

suspend fun moveChildrenInto(destDir: Path, force: Boolean = true)

Move this directory's children into the directory destDir, creating it if it does not exist.

moveInto

suspend fun moveInto(destDir: Path, force: Boolean = true)

Move this file or directory intodestDir, creating it if it does not exist.

readBytes

suspend fun readBytes(): ByteArray

Read this file.

readBytesSync

fun readBytesSync(): ByteArray

Read this file.

readStream

fun readStream(encoding: String? = "utf8"): <ERROR CLASS>

Create a stream to read the file.

readText

suspend fun readText(encoding: String = "utf8"): String

Read this file.

readTextSync

fun readTextSync(encoding: String = "utf8"): String

Read this file.

rename

fun rename(newName: String)

Synchronously rename the file or directory, erring if a file or directory already exists with the new name

requireDirectory

fun requireDirectory(requireExists: Boolean = true): Path

Throw if this path is not a directory, or doesn't exist and requireExists is true (as it is by default).

requireFile

fun requireFile(requireExists: Boolean = true): Path

Throw if this path is not a file, or doesn't exist and requireExists is true (as it is by default).

resolve

fun resolve(): Path

Resolve a path.

toString

open override fun toString(): String

touch

fun touch(): Path

Create an empty file if it doesn't exist, creating parent directories if necessary.

write

suspend fun write(data: <ERROR CLASS>, createParents: Boolean = true)